------------------------------------------------------------------------------
--                                                                          --
--                          PolyORB HI COMPONENTS                           --
--                                                                          --
--                P O L Y O R B _ H I . S U S P E N D E R S                 --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--               Copyright (C) 2007-2009 Telecom ParisTech,                 --
--                 2010-2019 ESA & ISAE, 2019-2021 OpenAADL                 --
--                                                                          --
-- PolyORB-HI is free software; you can redistribute it and/or modify under --
-- terms of the  GNU General Public License as published  by the Free Soft- --
-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
-- sion. PolyORB-HI is distributed in the hope that it will be useful, but  --
-- WITHOUT ANY WARRANTY; without even the implied warranty of               --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     --
--                                                                          --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception,   --
-- version 3.1, as published by the Free Software Foundation.               --
--                                                                          --
-- You should have received a copy of the GNU General Public License and    --
-- a copy of the GCC Runtime Library Exception along with this program;     --
-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
-- <http://www.gnu.org/licenses/>.                                          --
--                                                                          --
--              PolyORB-HI/Ada is maintained by the OpenAADL team           --
--                             (info@openaadl.org)                          --
--                                                                          --
------------------------------------------------------------------------------

---
--  # PolyORB_HI.Suspenders { #sec:pohi-suspenders }
--
--  This package implements routines to suspend application tasks

with PolyORB_HI_Generated.Deployment;
pragma Elaborate_All (PolyORB_HI_Generated.Deployment);

with Ada.Real_Time;
with PolyORB_HI.Epoch;

package PolyORB_HI.Suspenders
  with  SPARK_Mode => On,
        Abstract_State => (Elaborated_Variables with Synchronous,
                          External => (Effective_Reads,
                                       Effective_Writes,
                                       Async_Writers,
                                       Async_Readers)),
       Initializes => Elaborated_Variables
is

   use PolyORB_HI_Generated.Deployment;

   ---
   --  * ```Block_Task``` block the task ```Entity``` until
   -- ```Unblock_All_Tasks``` is called.
   --
   procedure Block_Task (Entity : Entity_Type);

   ---
   --  * ```Suspend_Forever``` suspends the calling task "forever", i.e.
   --  until Ada.Real_TIme.Time_Last.
   --
   procedure Suspend_Forever
         with Warnings => Off;

   pragma Warnings (On);

   ---
   --  * ```Unblock_All_Tasks``` unblocks all tasks suspended by
   --  ```Block_Tasks```.
   --
   procedure Unblock_All_Tasks
     with Global => (In_Out => (Elaborated_Variables,
                                Epoch.Elaborated_Variables),
                    Input => Ada.Real_Time.Clock_Time);

end PolyORB_HI.Suspenders;
